Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A Release Process #4097

Merged
merged 7 commits into from
Oct 10, 2024
Merged

A Release Process #4097

merged 7 commits into from
Oct 10, 2024

Conversation

poljar
Copy link
Contributor

@poljar poljar commented Oct 9, 2024

This PR introduces a cargo-release based release process. The changelogs are handled by git-cliff which cargo-release calls as a pre-release hook. An xtask was created to make the commands a bit more intuitive and the whole process a bit less manual.

This release process heavily aligns with what we have in vodozemac.

As a special bonus, a cargo release weekly-report was added which should help us when we need to write TWIM entries.

This would solve almost all the problems we have listed in #3742.

@poljar poljar requested a review from a team as a code owner October 9, 2024 11:15
@poljar poljar requested review from jmartinesp and removed request for a team October 9, 2024 11:15
@poljar poljar changed the title A release process A Release Process Oct 9, 2024
@poljar poljar requested a review from bnjbvr October 9, 2024 11:26
@poljar poljar mentioned this pull request Oct 9, 2024
11 tasks
Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.69%. Comparing base (81119a6) to head (ff2323c).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4097      +/-   ##
==========================================
- Coverage   84.70%   84.69%   -0.02%     
==========================================
  Files         269      269              
  Lines       28821    28821              
==========================================
- Hits        24412    24409       -3     
- Misses       4409     4412       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@jmartinesp jmartinesp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

benchmarks/Cargo.toml Show resolved Hide resolved
cliff-weekly-report.toml Show resolved Hide resolved
xtask/src/release.rs Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@bnjbvr bnjbvr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet, thanks for doing this. I'd really like to keep the scope at least for PR titles, and to keep something about those PR titles in the contribution guide, other than that, this looks great and I'm excited to start using it. Thanks a bunch for doing this 🫶

benchmarks/Cargo.toml Show resolved Hide resolved
cliff-weekly-report.toml Show resolved Hide resolved
cliff.toml Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
xtask/src/release.rs Outdated Show resolved Hide resolved
xtask/Cargo.toml Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
Copy link
Member

@Hywan Hywan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing my Markdown Defender hat

Excellent patch, thanks! I'm excited to use this!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
xtask/src/release.rs Outdated Show resolved Hide resolved
xtask/src/release.rs Show resolved Hide resolved
@poljar poljar force-pushed the poljar/release-process branch from 2d683db to ea043c1 Compare October 10, 2024 11:47
@poljar poljar force-pushed the poljar/release-process branch from ea043c1 to ff2323c Compare October 10, 2024 12:18
@poljar poljar enabled auto-merge (rebase) October 10, 2024 12:18
@poljar poljar merged commit 1260e74 into main Oct 10, 2024
41 checks passed
@poljar poljar deleted the poljar/release-process branch October 10, 2024 12:32
Comment on lines +95 to +96
Changelog: Added the `Ed25519PublicKey::to_base64()` method which can be used to
stringify the Ed25519 public key.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it correct/deliberate that this is written in the past tense ("[I have] added the method") rather than the more conventional imperative ("Add the method")? It looks jarring to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to open a PR to tweak the wording in that case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok thanks, just wanted to confirm it wasn't deliberate.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants